Skip to content

fix(docs): wrap first-column params to avoid table h-scroll#418

Merged
pratyush618 merged 1 commit into
masterfrom
fix/docs-param-table-wrap
Jul 12, 2026
Merged

fix(docs): wrap first-column params to avoid table h-scroll#418
pratyush618 merged 1 commit into
masterfrom
fix/docs-param-table-wrap

Conversation

@pratyush618

@pratyush618 pratyush618 commented Jul 12, 2026

Copy link
Copy Markdown
Collaborator

Problem

The queue.publish() parameter table on the Pub/Sub API reference page (and any table whose first column lists several parameters, e.g. priority / max_retries / timeout / expires / result_ttl) forced a horizontal scrollbar. The first column was white-space: nowrap, so a multi-token cell stayed on one line and widened the whole table past the content area, squeezing the description column off-screen.

Fix

Relax the first column to white-space: normal; overflow-wrap: normal. Individual identifiers still stay whole — the existing .md-table td code { white-space: nowrap } rule keeps each code token unbroken — so the cell now folds at the / separators instead of overflowing. Single-token first cells (idempotency_key, notes, …) are unaffected.

Result: the content wraps and the table fits its container. No horizontal scroll.

Verification

  • pnpm --dir docs lint — pass
  • pnpm --dir docs types:check — pass (pre-commit)
  • pnpm --dir docs build — static export succeeds; compiled bundle carries the new rule

Summary by CodeRabbit

  • Style
    • Updated documentation table styling so content in the first column wraps onto multiple lines instead of being forced to remain on one line.

@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cdcaa821-a84b-4bc7-a6b1-36bc09fbe0b4

📥 Commits

Reviewing files that changed from the base of the PR and between 943e2f6 and 7fc9ed2.

📒 Files selected for processing (1)
  • docs/app/styles/docs.css

📝 Walkthrough

Walkthrough

Updated markdown table styling so first-column cells can wrap across multiple lines instead of forcing horizontal expansion.

Changes

Markdown table wrapping

Layer / File(s) Summary
First-column wrapping behavior
docs/app/styles/docs.css
The first column uses normal whitespace and overflow wrapping, with comments documenting token-boundary wrapping behavior.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the docs table-wrapping fix and the goal of reducing horizontal scrolling.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-param-table-wrap

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the docs label Jul 12, 2026
@pratyush618
pratyush618 merged commit 446d140 into master Jul 12, 2026
15 checks passed
@pratyush618
pratyush618 deleted the fix/docs-param-table-wrap branch July 12, 2026 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant